Skip to main content

Set delivery method

POST 

/baskets/:id/provider/:providerBasketId/set-delivery-method

Sets the delivery method for a specific provider basket. Delivery methods that are available for a given provider will be on the provider order itself.

Request

Path Parameters

    id stringrequired

    The id of the basket

    providerBasketId stringrequired

    The id of the provider basket basket

Header Parameters

    x-api-key stringrequired

    The API key for the given store

Body

required
    deliveryMethod object required
    anyOf
    type stringrequired

    Possible values: [KioskCollection]

    kioskId stringrequired

    The id of the kiosk that the order will be collected from.

    collectionTime object
    type stringrequired

    Possible values: [KioskCollection, Address, Email]

    The type of the delivery method selection

    circular(Models.DeliveryMethods.KioskCollectionDeliverySelection)

Responses

The request has been accepted for processing, but processing has not yet completed.

Schema
    notificationId stringrequired

    The id of a notification that represents this asynchronous request. OneBasket will be processing the request in the background, and upon completion this notification will be updated with the result.

Loading...